package de.dopichaj.labrador.util.io.huffman;

import java.io.IOException;
import java.math.BigInteger;
import java.util.Map;

import de.dopichaj.labrador.util.io.BitInputStream;
import de.dopichaj.labrador.util.io.BitOutputStream;
import de.dopichaj.labrador.util.io.huffman.HuffmanTree.HuffmanCode;


/**
 * A leaf node in the Huffman tree.
 *
 * @param <T> the type of the associated data
 */
public final class LeafHuffmanNode<T> extends HuffmanNode<T> {
    
    private final T data;

    /**
     * @param data the data to associate with this node
     * @param count the occurrence count of this symbol
     */
    public LeafHuffmanNode(final T data, final int count) {
        super(count);
        this.data = data;
    }
    
    /**
     * Get the corresponding data.
     */
    public T getData() {
        return data;
    }

    @Override
    public void write(final BitOutputStream output, final HuffmanDataWriter<T> writer) throws IOException {
        
        // write the marker for "leaf node"
        output.writeBits(1, 1);
        
        // write the symbol
        writer.write(output, data);
    }

    @Override
    public T read(BitInputStream input) throws IOException {
        
        return getData();
    }

    @Override
    public void addToCodeMap(Map<T, HuffmanCode> map, BigInteger code, int significantBits) {
        map.put(getData(), new HuffmanCode(code, significantBits));
    }
}
/*
Copyright (c) 2007 Philipp Dopichaj

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/